home *** CD-ROM | disk | FTP | other *** search
/ Sound Fx / Sound Fx.iso / Software / UNZIPED / Tim3202i / timidity.txt < prev    next >
Text File  |  1996-06-01  |  15KB  |  463 lines
  1.  
  2.  
  3.  
  4. TiMidity(1)                                           TiMidity(1)
  5.  
  6.  
  7. NAME
  8.        TiMidity - MIDI to WAVE converter and player
  9.  
  10.  
  11. SYNOPSIS
  12.        timidity [-options] filename [filenames ...]
  13.  
  14.  
  15. DESCRIPTION
  16.        TiMidity  is  a MIDI to WAVE converter using Gravis Ultra¡
  17.        sound-compatible patch files  to  generate  digital  audio
  18.        data from General MIDI files.  The data can be stored in a
  19.        file for processing, or played in  real  time  through  an
  20.        audio device.
  21.  
  22.  
  23. OPTIONS
  24.        The following command line options are accepted by version
  25.        0.2i of TiMidity:
  26.  
  27.        -o filename
  28.               Place output on filename,  which  may  be  a  file,
  29.               device,  or  HP-UX  audio  server, depending on the
  30.               output mode selected with the -O option.  The  spe¡
  31.               cial  filename  ``-'' causes output to be placed on
  32.               stdout.
  33.  
  34.        -O mode
  35.               Selects the output mode from the compiled-in alter¡
  36.               natives.  mode must begin with one of the supported
  37.               output mode identifiers.  Run TiMidity with the  -h
  38.               option  to  see  a list.  The following identifiers
  39.               should be available in all versions:
  40.  
  41.               -Or    Generate  raw  waveform  data.   All  format
  42.                      options   are   supported.   Common  formats
  43.                      include:
  44.  
  45.                       -OrU   uLaw
  46.  
  47.                       -Or1sl 16-bit signed linear PCM
  48.  
  49.                       -Or8ul 8-bit unsigned linear PCM
  50.  
  51.               -Ow    Generate RIFF WAVE format output.  If output
  52.                      is  directed  to  a non-seekable file, or if
  53.                      TiMidity is interrupted before  closing  the
  54.                      file,   the   file   header   will   contain
  55.                      0xFFFFFFFF in the RIFF and data block length
  56.                      fields.   The popular sound conversion util¡
  57.                      ity sox  is  able  to  read  such  malformed
  58.                      files,  so you can pipe data directly to sox
  59.                      for on-the-fly conversion to other  formats.
  60.  
  61.  
  62.  
  63.  
  64.                             8 Sep 1995                          1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. TiMidity(1)                                           TiMidity(1)
  71.  
  72.  
  73.               Format options
  74.                      Option  characters  may be added immediately
  75.                      after the mode identifier to change the out¡
  76.                      put  format.  The following options are rec¡
  77.                      ognized:
  78.  
  79.  
  80.                       8      8-bit sample width
  81.  
  82.                       1      16-bit sample width
  83.  
  84.                       l      Linear encoding
  85.  
  86.                       U      uLaw (8-bit) encoding
  87.  
  88.                       M      Monophonic
  89.  
  90.                       S      Stereo
  91.  
  92.                       s      Signed output
  93.  
  94.                       u      Unsigned output
  95.  
  96.                       x      Byte-swapped output
  97.  
  98.               Note that some  options  have  no  effect  on  some
  99.               modes.   For  example,  you cannot generate a byte-
  100.               swapped RIFF WAVE file, or force uLaw output  on  a
  101.               Linux PCM device.
  102.  
  103.  
  104.        -s frequency
  105.               Sets  the  resampling  frequency.   Not  all  sound
  106.               devices  are  capable  of  all  frequencies  --  an
  107.               approximate frequency may be selected, depending on
  108.               the implementation.
  109.  
  110.        -a     Turns on antialiasing. Samples are  run  through  a
  111.               lowpass filter before playing, which reduces alias¡
  112.               ing noise at low resampling frequencies.
  113.  
  114.        -f     Toggles fast envelopes. Some MIDI files sound  bet¡
  115.               ter when notes decay slower -- it gives the impres¡
  116.               sion of reverb, which  TiMidity  doesn't  currently
  117.               support.
  118.  
  119.        -e     Make   TiMidity   evil.   On  Win32  version,  this
  120.               increases the task priority by  one.  It  can  give
  121.               better  playback  when  you  switch  tasks  at  the
  122.               expense of slowing all other tasks down.
  123.  
  124.        -p voices
  125.               Sets  polyphony  (maximum  number  of  simultaneous
  126.               voices) to voices.
  127.  
  128.  
  129.  
  130.                             8 Sep 1995                          2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. TiMidity(1)                                           TiMidity(1)
  137.  
  138.  
  139.        -A amplification
  140.               Multiplies the master volume by amplification%.
  141.  
  142.        -C ratio
  143.               Sets the ratio of sampling and control frequencies.
  144.               This determines how often  envelopes  are  recalcu¡
  145.               lated  -- small ratios yield better quality but use
  146.               more CPU time.
  147.  
  148.        -L directory
  149.               Adds directory to the library path.  Patch, config¡
  150.               uration,  and  MIDI  files  are searched along this
  151.               path.  Directories  added  last  will  be  searched
  152.               first.   Note  that the current directory is always
  153.               searched first before the library path.
  154.  
  155.        -c file
  156.               Reads an extra configuration file.
  157.  
  158.        -I number
  159.               Uses the program number as the default  instrument.
  160.               Any  Program Change events in MIDI files will over¡
  161.               ride this option.
  162.  
  163.        -P file
  164.               Uses the patch file for every program except drums.
  165.               Program  Change  events  will  be ignored.  This is
  166.               useful for testing new patches.
  167.  
  168.        -D channel
  169.               Marks channel as a drum  channel.   If  channel  is
  170.               negative,  channel -channel is marked as an instru¡
  171.               mental channel.  If channel is 0, all channels  are
  172.               marked as instrumental.
  173.  
  174.        -Q channel
  175.               Causes  channel  to  be quiet.  If channel is nega¡
  176.               tive, channel -channel is turned back on.  If chan¡
  177.               nel is 0, all channels are turned on.
  178.  
  179.        -F     Turns  on  fast  panning to accommodate MIDI pieces
  180.               that expect panning  adjustments  to  affect  notes
  181.               that  are  already  playing.  Some files that don't
  182.               expect  this  have  a  habit  of  flipping  balance
  183.               rapidly  between  left  and  right, which can cause
  184.               severe popping when the -F flag is used.
  185.  
  186.        -U     Instructs TiMidity to unload all  instruments  from
  187.               memory  between MIDI files.  This can reduce memory
  188.               requirements when playing many files in succession.
  189.  
  190.        -i interface
  191.               Selects  the  user  interface  from the compiled-in
  192.               alternatives.  interface must begin with one of the
  193.  
  194.  
  195.  
  196.                             8 Sep 1995                          3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. TiMidity(1)                                           TiMidity(1)
  203.  
  204.  
  205.               supported interface identifiers.  Run TiMidity with
  206.               the -h option to see a list.  The following identi¡
  207.               fiers may be available:
  208.  
  209.               -id    The   dumb   interface  --  plays  files  in
  210.                      sequence, prints messages according to  ver¡
  211.                      bosity level.  The trace mode shows the cur¡
  212.                      rent and total playing time.
  213.  
  214.               -im    The motif interface -- X Window  interactive
  215.                      interface.
  216.  
  217.               -ik    The Tcl/Tk interface -- X Window interactive
  218.                      interface.
  219.  
  220.               -in    The  ncurses  full-screen   interface   with
  221.                      interactive controls.
  222.  
  223.               -is    The S-Lang full-screen interface with inter¡
  224.                      active controls.
  225.  
  226.               Interface options
  227.                      Option characters may be  added  immediately
  228.                      after the interface identifier.  The follow¡
  229.                      ing options are recognized:
  230.  
  231.                       v      Increases verbosity.  This option is
  232.                              cumulative.
  233.  
  234.                       q      Decreases verbosity.  This option is
  235.                              cumulative.
  236.  
  237.                       t      Toggles trace mode.  In trace  mode,
  238.                              TiMidity  attempts  to  display  its
  239.                              current state in real time.  For the
  240.                              Linux  sound  driver, this is accom¡
  241.                              plished through the use of short DMA
  242.                              buffer fragments, which can be tuned
  243.                              via the -B option.
  244.  
  245.  
  246.  
  247.        -B fragments
  248.               For the Linux sound driver, selects the  number  of
  249.               buffer  fragments  in interactive mode.  Increasing
  250.               the number of fragments may reduce choppiness  when
  251.               many  processes are running.  It will make TiMidity
  252.               seem to respond sluggishly to fast forward, rewind,
  253.               and  volume  controls, and it will throw the status
  254.               display off sync.  Specify a fragments of 0 to  use
  255.               the maximum number of fragments available.
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.                             8 Sep 1995                          4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. TiMidity(1)                                           TiMidity(1)
  269.  
  270.  
  271. FILES
  272.        TiMidity  looks for the configuration file timidity.cfg at
  273.        startup, before processing any options.  If  it  can't  be
  274.        accessed, and the library path is changed with a -L option
  275.        on the command line, then the default file will be  sought
  276.        again  along  the  new  library  path after processing all
  277.        options, unless another configuration file  was  specified
  278.        with the -c option.
  279.  
  280.        Configuration files define the mapping of MIDI programs to
  281.        instrument files.  Multiple files may  be  specified,  and
  282.        statements  in later ones will override earlier ones.  The
  283.        following statements can be used in a configuration file:
  284.  
  285.        dir directory
  286.               Adds directory to the search path in the same  man¡
  287.               ner as the -L command line option.
  288.  
  289.        source file
  290.               Reads  another  configuration  file, then continues
  291.               processing the current one.
  292.  
  293.        bank number
  294.               Selects the tone bank to  modify.   Patch  mappings
  295.               that follow will affect this tone bank.
  296.  
  297.        drumset number
  298.               Selects  the  drum  set  to modify.  Patch mappings
  299.               that follow will affect this drum set.
  300.  
  301.        number file [options]
  302.               Specifies that the the MIDI program number  in  the
  303.               current  tone  bank  or  drum  set should be played
  304.               using the patch file.  options may be  any  of  the
  305.               following:
  306.  
  307.               amp=amplification
  308.                      Amplifies  the instrument's volume by ampli¡
  309.                      fication percent.  If no value is specified,
  310.                      one  will  be automatically determined when¡
  311.                      ever the instrument is loaded.
  312.  
  313.               note=note
  314.                      Specifies a fixed  MIDI  note  to  use  when
  315.                      playing  the  instrument.  If note is 0, the
  316.                      instrument will be played at  whatever  note
  317.                      the  Note  On  event  triggering it has. For
  318.                      percussion instruments, if no value is spec¡
  319.                      ified in the configuration file, the default
  320.                      in the patch file will be used.
  321.  
  322.               pan=panning
  323.                      Sets the instrument's default panning.  pan¡
  324.                      ning  may  be  left,  right,  center,  or an
  325.  
  326.  
  327.  
  328.                             8 Sep 1995                          5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. TiMidity(1)                                           TiMidity(1)
  335.  
  336.  
  337.                      integer between -100  and  100,  designating
  338.                      full  left  and full right respectively.  If
  339.                      no value is specified, the  default  in  the
  340.                      patch  file will be used.  Note that panning
  341.                      controls in MIDI files  will  override  this
  342.                      value.
  343.  
  344.               keep={loop|env}
  345.                      By   default,  percussion  instruments  have
  346.                      their   loop   and   envelope    information
  347.                      stripped.  Strangely  shaped  envelopes  are
  348.                      removed automatically from  melodic  instru¡
  349.                      ments  as  well. keep can be used to prevent
  350.                      stripping envelope or loop data.  For  exam¡
  351.                      ple,  the  Short and Long Whistle percussion
  352.                      instruments (General Midi numbers 71 and 72)
  353.                      need  to  have ``keep=loop keep=env'' speci¡
  354.                      fied in the configuration file.
  355.  
  356.               strip={loop|env|tail}
  357.                      Force removal of loop or  envelope  informa¡
  358.                      tion  from all patches in the instrument, or
  359.                      strip the tail,  i.e.  all  data  after  the
  360.                      loop.   Some  third-party  instruments  have
  361.                      garbage after the loop, as  evidenced  by  a
  362.                      clicking  noise  whenever  the instrument is
  363.                      played, so adding the strip=tail option will
  364.                      markedly improve sound quality.
  365.  
  366.  
  367.        NOTE: Whenever any filename ends in one of the compiled-in
  368.        compression identifiers, such as .gz,  or  .sht,  TiMidity
  369.        will  pipe  the file through the appropriate decompressor.
  370.        MIDI files often compress very well,  so  the  ability  to
  371.        handle compressed files can be useful.
  372.  
  373.        The special filename ``-'' can be used on the command line
  374.        to indicate that a MIDI file should be read from stdin.
  375.  
  376.  
  377. COPYRIGHT
  378.        Copyright (C) 1995 Tuukka Toivonen.
  379.  
  380.        TiMidity is free software; you can redistribute it  and/or
  381.        modify  it  under  the  terms  of  the  GNU General Public
  382.        License as published  by  the  Free  Software  Foundation;
  383.        either  version  2 of the License, or (at your option) any
  384.        later version.
  385.  
  386.        TiMidity is distributed in the hope that it will  be  use¡
  387.        ful,  but  WITHOUT  ANY WARRANTY; without even the implied
  388.        warranty of MERCHANTABILITY or FITNESS  FOR  A  PARTICULAR
  389.        PURPOSE.   See  the  GNU  General  Public License for more
  390.        details.
  391.  
  392.  
  393.  
  394.                             8 Sep 1995                          6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. TiMidity(1)                                           TiMidity(1)
  401.  
  402.  
  403. AVAILABILITY
  404.        The latest release is available on the TiMidity Home Page,
  405.        URL http://www.clinet.fi/~toivonen/timidity/.
  406.  
  407. BUGS
  408.        8-bit and low-rate output sounds worse than it should.
  409.  
  410.        Eats more CPU time than a small CPU-time-eating animal.
  411.  
  412. AUTHORS
  413.        Tuukka Toivonen <toivonen@clinet.fi>
  414.        HP-UX  audio code, X-Motif interface, icons and antialias¡
  415.        ing filter by Vincent Pagel <pagel@loria.fr>
  416.        Tcl/Tk  interface  by  Takashi  Iwai  <iwai@dragon.mm.t.u-
  417.        tokyo.ac.jp>
  418.        Windows    95/NT    audio    code    by   Davide   Moretti
  419.        <dmoretti@iper.net>
  420.        DEC     audio     code     by      Chi      Ming      HUNG
  421.        <cmhung@insti.physics.sunysb.edu>
  422.        S-Lang   user   interface   by  Riccardo  Facchetti  <ric¡
  423.        cardo@cdc8g5.cdc.polimi.it>
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.                             8 Sep 1995                          7
  461.  
  462.  
  463.